<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>proDOC : : how to generate the final documentation</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<style type="text/css">
<!--
body {
	margin-left: 0px;
	margin-top: 0px;
	margin-right: 0px;
	margin-bottom: 0px;
	background-color: #FFFFFF;
}
A:link {
	color: #000000;
	text-decoration: none
}
A:visited {
	color: #000000;
	text-decoration: none
}											
A:active {
	color: #999900; 
	text-decoration: none
}
A:hover {
	color: #999900;
	text-decoration: none;
}
-->
</style>
<link href="stylesheet.css" rel="stylesheet" type="text/css">
</head>
<body>
<center>
<table width="600" border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td width="75" height="100" valign="top" class="header"><img src="images/prodoc.gif" width="127" height="40">
        <img src="images/index.gif" width="91" height="50" border="0" usemap="#MapMap"></td>
    <td width="450" class="descList">&nbsp;</td>
  </tr>
  <tr>
    <td valign="top">&nbsp;</td>
    <td class="methodName">How to generate the final documentation</td>
  </tr>
  <tr>
    <td valign=top>&nbsp;</td>
    <td valign=top class="descList"> <p>When you have made all the necessary comments in the sourcecode and maybe build a custom template, its time to let proDOC run over your source code. If you use eclipse exporting the doc is quiet easy. Your library should be a project in eclipse, in the package explorer click right on your project. Choose export in the appearing menue and then choose javadoc and click next.<br>
          <br>
        Now you have the javadoc generation dialog. First make sure only your library project is selected. Select use custom doclet, this is the point where you have to tell eclipse, that the doc has to be generated by proDOC. So in the field &quot;Doclet name&quot; enter: prodoc.StartDoclet. In the next field &quot; Doclet class path&quot; you have to enter the path to the prodoc.jar file, placed in the prodoc installation folder. Finally press finnish and the doc should be generated.<br>
        <br>
        If you do not use eclipse, think about using it, or generate the documentation with the commandline. Here is an example:    
      <pre>c:\javadoc -doclet prodoc.StartDoclet -docletpath c:\the\path\to\prodoc <br>-sourcepath  c:\the\path\to\your_lib</pre>
      I tried to implement an exceptionhandling that gives you information about errors during the generation, so that you know where you made mistakes in the template files or sourcecode comments. If everything worked you should find the complete documentation in a new documentation folder inside your lib. </td>
  </tr>
  <tr>
    <td><img src="video/images/1pix.gif" width="1" height="25"></td>
    <td class="descList">&nbsp;</td>
  </tr>
</table>
<br>
<br>
<br>
<br>
</center>
<map name="MapMap">
  <area shape="rect" coords="3,13,88,34" href="index.html">
</map>
</body>
</html>
